home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 2000 #4 / Amiga Plus CD - 2000 - No. 4.iso / Tools / Dev / Bgui / AutoDoc / buttonclass.doc < prev    next >
Encoding:
Text File  |  2000-05-09  |  2.5 KB  |  98 lines
  1. TABLE OF CONTENTS
  2.  
  3. buttonclass/--background--
  4. buttonclass/BUTTON_EncloseImage
  5. buttonclass/BUTTON_(Selected)Image
  6. buttonclass/GA_Selected
  7.  
  8. buttonclass/--background--
  9.  
  10.     NAME
  11.     Class:        buttonclass
  12.     Superclass:    baseclass
  13.     Include File:    <llibraries/bgui.h>
  14.  
  15.     FUNCTION
  16.     To provide a gadget simular to the gadtools.library button  kind.  The
  17.     gadget can either be a normal button or a toggle button.   Vectorclass
  18.     attributes can be passed at create time to add imagery to the gadget.
  19.  
  20.  
  21.     The  gadget  will  send  the following attributes in it's notification
  22.     events:
  23.  
  24.     GA_ID        - Gadget object ID.
  25.     GA_UserData    - Gadget object userdata contents.
  26.     GA_Selected    - Gadget object selected state.
  27.  
  28.     NOTES
  29.     Please    note  that  the (non-toggle) objects from this class will send
  30.     out  interim  notification  messages every single timer tick while the
  31.     gadget is selected.
  32.  
  33.     The vectorclass attributes VIT_VectorArray, VIT_BuiltIn,  VIT_Pen  and
  34.     VIT_DriPen  attributes are also settable with OM_SET or OM_UPDATE when
  35.     the button object has a vector image attached to it.
  36.  
  37. buttonclass/BUTTON_EncloseImage
  38.  
  39.     NAME
  40.     BUTTON_EncloseImage -- ( BOOL ) ** V39 **
  41.  
  42.     FUNCTION
  43.     By default the buttonclass keeps a gap between the  actual  image  and
  44.     a frame which may be attached to the object. When you specify this tag
  45.     as  TRUE  this    gap  will  not be there and the frame will enclose the
  46.     image.
  47.  
  48.     When setting this tag on a button with a label the object can be sized
  49.     as small as the label width and height.
  50.  
  51.     DEFAULT
  52.     FALSE.
  53.  
  54.     APPLICABILITY
  55.     (I).
  56.  
  57. buttonclass/BUTTON_(Selected)Image
  58.  
  59.     NAME
  60.     BUTTON_Image, BUTTON_SelectedImage -- ( struct Image * )
  61.  
  62.     FUNCTION
  63.     To provide a button object width a standard Intuition or BOOPSI image.
  64.     The images will be centered  inside the object    it's hitbox.  You  can
  65.     supply a selected image which is  shown when  the gadget  is selected.
  66.     If no selected imagery is  specified  the normal  image is  also shown
  67.     when the gadget is selected.
  68.  
  69.     These attribute overides the creation of a VectorClass image.
  70.  
  71.     NOTE
  72.     Since V39 of the library the images can be  changed  with  OM_SET  and
  73.     OM_UPDATE. You are responsible to make sure the images you change will
  74.     still fit in the object.
  75.  
  76.     DEFAULTS
  77.     NULL.
  78.  
  79.     APPLICABILITY
  80.     (ISU).
  81.  
  82. buttonclass/GA_Selected
  83.  
  84.     NAME
  85.     GA_Selected - ( BOOL )
  86.  
  87.     FUNCTION
  88.     This  attributes  has  an  extended  applicability.  It  has been made
  89.     get-able  to  make  it    easy to inquire about the selected state of an
  90.     object.
  91.  
  92.     DEFAULT
  93.     FALSE.
  94.  
  95.     APPLICABILITY
  96.     (ISGNU).
  97.  
  98.